.TH E1432_CHECK_SPECTRUM 3 E1432
.SH NAME
e1432_check_spectrum \- Check if requested frequency spectrum is ready
.IX e1432_check_spectrum(3) 3
.SH SYNOPSIS
.cS
SHORTSIZ16 e1432_check_spectrum(E1432ID hw, SHORTSIZ16 ID, SHORTSIZ16 block)
.cE
.SH DESCRIPTION
This function applies only the the E1432 option 204 firmware.

The \fIe1432_check_spectrum\fR function is used to check if a requested
frequency spectrum has completed and is ready to read into the host
computer.  The original request must have been made with
\fIe1432_request_spectrum\fR.

\fIhw\fR must be the result of a successful call to
\fIe1432_assign_channel_numbers\fR, and specifies the group of
hardware to talk to.

\fIID\fR is either the ID of a group of channels that was obtained with a
call to \fIe1432_create_channel_group\fR, or the ID of a single
channel.

\fIblock\fR specifies whether this function should block.  If set to
zero, the function returns immediately, and indicates whether a
spectrum is ready or not.  If \fIblock\fR is non-zero, then
\fIe1432_check_spectrum\fR blocks (sleeps) until the spectrum is
ready, before returning.

.SH "RESET VALUE"
Not applicable.
.SH "RETURN VALUE"
Returns 1 if a spectrum is ready, 0 if no spectrum is ready, or a
(negative) error number if something went wrong.
.SH "SEE ALSO"
.na
e1432_request_spectrum, e1432_read_float32_spectrum,
e1432_read_float64_spectrum.
.ad
